<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <style xmlns="" type="text/css">
    /* This style sets a margin around the entire page */
        html, body {
            margin: 10px;
        }

        p {
            font: normal 16px verdana, sans-serif;
            margin: 0;
            padding-bottom:12px;
        }

        h1 {
            font: bold 25px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h2 {
            font: bold 19px verdana, sans-serif;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h3 {
            font: bold 19px verdana, sans-serif !important;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        li {
            font: normal 16px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 18px;
            padding-top: 0;
            padding-bottom: 0;
        }

        .pdparam {
            font: italic 16px verdana, sans-serif;
        }

                .term {
                        font: italic 16px verdana, sans-serif;
                        font-weight: normal;
                }

                .type {
                        font: normal 16px verdana, sans-serif !important;
                }

                .parameter {
                        font-style: italic;
                        }

        a:link, a:visited {
            color: blue;
            text-decoration: none;
            font: normal 16px;
        }

        a:hover {
            background-color: #FFFF99;
            font: normal 16px;
        }

        div.funcsynopsis {
            text-align: left;
            background-color: #e6e6e6;
            font: normal 16px verdana, sans-serif;
                        padding-top: 10px;
                        padding-bottom: 10px;
        }

        div.funcsynopsis table {
            border-collapse: separate;
            font: normal 16px verdana, sans-serif;
        }

        div.funcsynopsis td {
            background-color: #e6e6e6;
            border: 0 solid #000;
            padding: 1px;
            font: normal 16px verdana, sans-serif;
        }

        div.refsect1 {
            font-family: verdana, sans-serif;
            font-size: 16px;
        }

        code.constant {
            font: normal 16px courier new, monospace !important;
        }

                span.errorname {
            font: normal 16px verdana, sans-serif !important;
        }

        code.function {
            font: bold 16px verdana, sans-serif !important;
        }

        b.fsfunc {
            font: bold 16px verdana, sans-serif !important;
        }

        code.varname {
            font: italic 16px verdana, sans-serif;
        }

        code.replaceable {
            font: italic 16px courier new, monospace;
        }

        code.funcdef {
            font: normal 16px verdana, sans-serif !important;
        }

        .citerefentry {
            font: normal 16px verdana, sans-serif !important;
        }

        .parameter {
            font-style: italic;
        }

        code.fsfunc {
            font: normal 16px verdana, sans-serif !important;
        }

        /* PARAMETER: This style controls spacing between the terms in Parameter section */
        dt {
            margin-top: 15px;
        }

        /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
        div.refsect1 table {
            width: 100%;
                        margin-top: 10px;
            background-color: #FFF;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
                        font: normal 16px verdana, sans-serif;
        }

        div.refsect1 th {
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: bold 16px verdana, sans-serif;
        }

        div.refsect1 td {
            background-color: #FFF;
            padding: 5px;
            vertical-align: text-top;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: normal 16px verdana, sans-serif;
        }

                  div.refsect1 p{
            font: normal 16px verdana, sans-serif;
            margin-top: 8px;
            margin-bottom: 8px;
            padding-top: 0;
            padding-bottom: 0;
        }


        /* EXAMPLE: These styles apply only to the Example section */
        div.refsect2 {
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 table {
            margin-top: 0;
            background-color: #e6e6e6;
            width: 100%;
            border: 0 solid #000;
            padding: 2px;
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 td {
            background-color: #e6e6e6;
            font: normal 16px courier new, monospace !important;
                        white-space:pre;
        }

        /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
        div.refsect3 {
            font: normal 11px verdana, sans-serif;
            margin-top: 50px;
            margin-bottom: 20px;
            padding-top: 0;
            padding-bottom: 0;
        }

</style>
    <title>cl_khr_mipmap_image</title>
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <meta name="keywords" content="cl_khr_mipmap_image" />
  </head>
  <body>
    <div class="refentry">
      <a id="id-1"></a>
      <div class="titlepage"></div>
      <div xmlns="" class="refnamediv">
        <a xmlns="http://www.w3.org/1999/xhtml" id="cl_khr_mipmap_image"></a>
        <h1>cl_khr_mipmap_image</h1>
        <p>
            Extension adds support for mipmaps.
        </p>
      </div>
      <div class="refsect2">
        <a id="synopsis"></a>
        <h3>
        </h3>
        <div class="informaltable">
          <table border="0">
            <colgroup>
              <col align="left" class="col1" />
            </colgroup>
            <tbody>
              <tr>
                <td align="left">
#pragma OPENCL EXTENSION cl_khr_mipmap_image : enable
                        </td>
              </tr>
              <tr>
                <td align="left">
#pragma OPENCL EXTENSION cl_khr_mipmap_image_writes : enable
                        </td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="description"></a>
        <h2>Description</h2>
        <p>
            This extension adds support for mipmaps. This proposal is implemented 
            as two optional extensions. The <code class="function">cl_khr_mipmap_image</code> 
            extension implements support to create a mipmapped image, enqueue commands 
            to read/write/copy/map a region of a mipmapped image and built-in 
            functions that can be used to read a mip-mapped image in an OpenCL C 
            program. The <code class="function">cl_khr_mipmap_image_writes</code> extension 
            adds built-in functions that can be used to write a mip-mapped image in 
            an OpenCL C program. If the <code class="function">cl_khr_mipmap_image_writes</code> 
            extension is supported by the OpenCL device, the 
            <code class="function">cl_khr_mipmap_image</code> extension must also be supported.
        </p>
        <h4><a id="id-1.5.3"></a>Additions to section 5.3 – Image Objects:</h4>
        <p>
            A mip-mapped 1D image, 1D image array, 2D image, 2D image array 
            or 3D image is created by specifying <code class="varname">num_mip_levels</code> 
            to be a value &gt; 1 in <code class="varname">cl_image_desc</code> passed to 
            <a class="citerefentry" href="clCreateImage.html"><span class="citerefentry"><span class="refentrytitle">clCreateImage</span></span></a>. 
            The dimensions of a mip-mapped image can be a power of two or a 
            non-power of two. Each successively smaller mipmap level is half 
            the size of the previous level. If this half value is a fractional 
            value, it is rounded down to the nearest integer.
        </p>
        <div class="itemizedlist">
          <ul class="itemizedlist" style="list-style-type: disc; ">
            <li class="listitem">
                The following restrictions apply when mip-mapped images are created 
                with <a class="citerefentry" href="clCreateImage.html"><span class="citerefentry"><span class="refentrytitle">clCreateImage</span></span></a>:
            </li>
            <li class="listitem"><code class="constant">CL_MEM_USE_HOST_PTR</code> or <code class="constant">CL_MEM_COPY_HOST_PTR</code> 
                cannot be specified if a mipmapped image is created.
            </li>
            <li class="listitem">
                The <code class="varname">host_ptr</code> argument to 
                <a class="citerefentry" href="clCreateImage.html"><span class="citerefentry"><span class="refentrytitle">clCreateImage</span></span></a> 
                must be a NULL value.
            </li>
            <li class="listitem">
                Mip-mapped images cnnot be created for <code class="constant">CL_MEM_OBJECT_IMAGE1D_BUFFER</code> 
                images and multi-sampled (i.e. msaa) images.
            </li>
          </ul>
        </div>
        <p>
            Calls to <a class="citerefentry" href="clEnqueueReadImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReadImage</span></span></a>, 
            <a class="citerefentry" href="clEnqueueWriteImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueWriteImage</span></span></a>, and 
            <a class="citerefentry" href="clEnqueueMapImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapImage</span></span></a> can be used
            to read from or write to a specific mip-level of a mip-mapped image. 
            If <code class="varname">image</code> argument is a 1D image, 
            <code class="varname">origin</code>[1] specifies the mip-level to use. 
            If <code class="varname">image</code> argument is a 1D image array, 
            <code class="varname">origin</code>[2] specifies the mip-level to use. 
            If <code class="varname">image</code> argument is a 2D image, 
            <code class="varname">origin</code>[3] specifies the mip-level to use. 
            If <code class="varname">image</code> argument is a 2D image array or a 3D image, 
            <code class="varname">origin</code>[3] specifies the mip-level to use.
        </p>
        <p>
            Calls to <a class="citerefentry" href="clEnqueueCopyImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueCopyImage</span></span></a>, 
            <a class="citerefentry" href="clEnqueueCopyImageToBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueCopyImageToBuffer</span></span></a>, and
            <a class="citerefentry" href="clEnqueueCopyBufferToImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueCopyBufferToImage</span></span></a> can also 
            be used to copy from and to a specific mip-level of a mip-mapped image. 
            If <code class="varname">src_image</code> argument is a 1D image, 
            <code class="varname">src_origin</code>[1] specifies the mip-level to use. 
            If <code class="varname">src_image</code> argument is a 1D image array, 
            <code class="varname">src_origin</code>[2] specifies the mip-level to use.
            If <code class="varname">src_image</code> argument is a 2D image, 
            <code class="varname">src_origin</code>[3] specifies the mip-level to use. 
            If <code class="varname">src_image</code> argument is a 2D image array or a 3D image, 
            <code class="varname">src_origin</code>[3] specifies the mip-level to use. 
            If <code class="varname">dst_image</code> argument is a 1D image, 
            <code class="varname">dst_origin</code>[1] specifies the mip-level to use. 
            If <code class="varname">dst_image</code> argument is a 1D image array, 
            <code class="varname">dst_origin</code>[2] specifies the mip-level to use. 
            If <code class="varname">dst_image</code> argument is a 2D image, 
            <code class="varname">dst_origin</code>[3] specifies the mip-level to use. 
            If <code class="varname">dst_image</code> argument is a 2D image array or a 3D image, 
            <code class="varname">dst_origin</code>[3] specifies the mip-level to use.
        </p>
        <p>
            If the mip level specified is not a valid value, these functions 
            return the error <span class="errorname">CL_INVALID_MIP_LEVEL</span>.
        </p>
        <h4><a id="id-1.5.9"></a>Additions to section 5.7 – Sampler Objects:</h4>
        <p>
            Add the following sampler properties that can be specified when a sampler object is created using 
            <a class="citerefentry" href="clCreateSamplerWithProperties.html"><span class="citerefentry"><span class="refentrytitle">clCreateSamplerWithProperties</span></span></a>.
        </p>
        <div class="informaltable">
          <table border="1">
            <colgroup>
              <col align="left" class="col1" />
              <col align="left" class="col2" />
              <col align="left" class="col3" />
            </colgroup>
            <thead>
              <tr>
                <th align="left">cl_sampler_properties enum</th>
                <th align="left">Property Value</th>
                <th align="left">Default Value</th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td align="left">
                  <code class="constant">CL_SAMPLER_MIP_FILTER_MODE</code>
                </td>
                <td align="left">cl_filter_mode</td>
                <td align="left">
                  <code class="constant">CL_FILTER_NONE</code>
                </td>
              </tr>
              <tr>
                <td align="left">
                  <code class="constant">CL_SAMPLER_LOD_MIN</code>
                </td>
                <td align="left">float</td>
                <td align="left">0.0f</td>
              </tr>
              <tr>
                <td align="left">
                  <code class="constant">CL_SAMPLER_LOD_MAX</code>
                </td>
                <td align="left">float</td>
                <td align="left">
                  <code class="constant">MAXFLOAT</code>
                </td>
              </tr>
            </tbody>
          </table>
        </div>
        <p>
            NOTE: The sampler properties <code class="constant">CL_SAMPLER_MIP_FILTER_MODE</code>,
             <code class="constant">CL_SAMPLER_LOD_MIN</code>, and 
            <code class="constant">CL_SAMPLER_LOD_MAX</code> cannot be specified with any 
            samplers initialized in the OpenCL program source. Only the default 
            values for these properties will be used. To create a sampler with 
            specific values for these properties, a sampler object must be created with
            <a class="citerefentry" href="clCreateSamplerWithProperties.html"><span class="citerefentry"><span class="refentrytitle">clCreateSamplerWithProperties</span></span></a> 
            and passed as an argument to a kernel.
        </p>
        <h4><a id="id-1.5.13"></a>Additions to section 6.13.14 – Image Read, Write, and Query Functions</h4>
        <p>
            The image read and write functions read from and write to mip-level 
            0 if the <code class="varname">image</code> argument is a mip-mapped image. 
            New built-in image read, write, and query functions are added to the 
            <a class="citerefentry" href="imageFunctions.html"><span class="citerefentry"><span class="refentrytitle">image functions</span></span></a> 
            available.
        </p>
        <p>
            NOTE: <code class="constant">CL_SAMPLER_NORMALIZED_COORDS</code> must be 
            <code class="constant">CL_TRUE</code> for the new built-in read functions 
            referred to above that read from a mip-mapped image; otherwise 
            the behavior is undefined. The value specified in the 
            <code class="varname">lod</code> argument is clamped to the minimum of 
            (actual number of mip-levels – 1) in the image or value 
            specified for <code class="constant">CL_SAMPLER_LOD_MAX</code>.
        </p>
        <h4><a id="id-1.5.16"></a>Additions to section 9.7 – Sharing Memory Objects with OpenGL / OpenGL ES Texture Objects</h4>
        <p>
            If the <code class="function">cl_khr_mipmap_image</code> extension is 
            supported by the OpenCL device, the 
            <a class="citerefentry" href="cl_khr_gl_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_gl_sharing</span></span></a> 
            extension adds support for creating a mip-mapped CL image from a mip-mapped GL texture.
        </p>
        <p>
            To create a mip-mapped CL image from a mip-mapped GL texture, the 
            <code class="varname">miplevel</code> argument to 
            <a class="citerefentry" href="clCreateFromGLTexture.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromGLTexture</span></span></a> 
            should be a negative value. If <code class="varname">miplevel</code> is a negative 
            value then a CL mipmapped image object is created from a mipmapped 
            GL texture object instead of a CL image object for a specific 
            miplevel of a GL texture.
        </p>
      </div>
      <div class="refsect1">
        <a id="specification"></a>
        <h2>Specification</h2>
        <p>
            <img src="pdficon_small1.gif" />

            <a href="https://www.khronos.org/registry/cl/specs/opencl-2.0-extensions.pdf#page=141" target="OpenCL Spec">OpenCL Specification</a>
        </p>
      </div>
      <div class="refsect1">
        <a id="seealso"></a>
        <h2>Also see</h2>
        <p>
            <a class="citerefentry" href="EXTENSION.html"><span class="citerefentry"><span class="refentrytitle">EXTENSION</span></span></a>,
            <a class="citerefentry" href="clCreateProgramWithBinary.html"><span class="citerefentry"><span class="refentrytitle">clCreateProgramWithBinary</span></span></a>,
            <a class="citerefentry" href="imageFunctions.html"><span class="citerefentry"><span class="refentrytitle">Image Functions</span></span></a>,
            <a class="citerefentry" href="clCreateFromGLTexture.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromGLTexture</span></span></a>,
            <a class="citerefentry" href="clEnqueueCopyImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueCopyImage</span></span></a>, 
            <a class="citerefentry" href="clEnqueueCopyImageToBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueCopyImageToBuffer</span></span></a>, 
            <a class="citerefentry" href="clEnqueueCopyBufferToImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueCopyBufferToImage</span></span></a>, 
            <a class="citerefentry" href="clEnqueueReadImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReadImage</span></span></a>, 
            <a class="citerefentry" href="clEnqueueWriteImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueWriteImage</span></span></a>,  
            <a class="citerefentry" href="clEnqueueMapImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapImage</span></span></a>, 
            <a class="citerefentry" href="clCreateImage.html"><span class="citerefentry"><span class="refentrytitle">clCreateImage</span></span></a>
        </p>
      </div>
      <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2013 The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.
</div>
    </div>
  </body>
</html>
